Package com.cisco.pt.ipc.sim.impl
Class PPPoeClientImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.ProcessImpl
com.cisco.pt.ipc.sim.impl.PPPoeClientImpl
- All Implemented Interfaces:
IPCObject,PPPoeClient,Process
Information provided by the PKI file:
\class PppoeClient
\brief PppoeClient handles and manipulates the PPPoE client.
\example network().getDevice("PC0").getProcess("PppoeClient")
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionPPPoeClientImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptionvoidInformation provided by the PKI file:voidconnectFromPc(String userName, String password) voiddisconnect(int sessionId, PPPoeConnectionStatus status, boolean sendTerminalFlag) Information provided by the PKI file:voidInformation provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:booleanInformation provided by the PKI file:voidsetConnected(boolean flag) Information provided by the PKI file:voidInformation provided by the PKI file:voidsetPassword(String password) Information provided by the PKI file:voidsetServiceName(String service) Information provided by the PKI file:voidsetUsername(String userName) Information provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.sim.impl.ProcessImpl
getOwnerDeviceMethods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSessionMethods inherited from interface com.cisco.pt.ipc.sim.Process
getOwnerDevice
-
Constructor Details
-
PPPoeClientImpl
public PPPoeClientImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
setUsername
Information provided by the PKI file:
\brief Sets the username. \param userName, the username.- Specified by:
setUsernamein interfacePPPoeClient- Parameters:
userName- Takes in a parameter of userName
-
setConnectionStatus
Information provided by the PKI file:
\brief Sets the status. \param status, the status types: eConnected = 0, eConnecting = 1, ePoolRejected = 2, eDisconnected = 3, eTimeout = 4, eNoKeepAlive = 5, eAuthentcationFailed = 6- Specified by:
setConnectionStatusin interfacePPPoeClient- Parameters:
status- Takes in a parameter of status
-
getUsername
Information provided by the PKI file:
\brief Gets the username. \return string, the username.- Specified by:
getUsernamein interfacePPPoeClient- Returns:
- String Returns a String
-
setPassword
Information provided by the PKI file:
\brief Sets the password. \param password, the password.- Specified by:
setPasswordin interfacePPPoeClient- Parameters:
password- Takes in a parameter of password
-
getPassword
Information provided by the PKI file:
\brief Gets the password. \return, the password.- Specified by:
getPasswordin interfacePPPoeClient- Returns:
- String Returns a String
-
setServiceName
Information provided by the PKI file:
\brief Sets the service name. \param service, the service name to use.- Specified by:
setServiceNamein interfacePPPoeClient- Parameters:
service- Takes in a parameter of service
-
getServiceName
Information provided by the PKI file:
\brief Gets the service name. \return string, the service name to use.- Specified by:
getServiceNamein interfacePPPoeClient- Returns:
- String Returns a String
-
connect
Information provided by the PKI file:
\brief Makes a PPPoE connection with the specified username and password. \param userName, the username. \param password, the password.- Specified by:
connectin interfacePPPoeClient- Parameters:
userName- Takes in a parameter of userNamepassword- Takes in a parameter of password
-
connectFromPc
- Specified by:
connectFromPcin interfacePPPoeClient- Parameters:
userName- Takes in a parameter of userNamepassword- Takes in a parameter of password
-
disconnectFromPc
public void disconnectFromPc()- Specified by:
disconnectFromPcin interfacePPPoeClient
-
disconnect
Information provided by the PKI file:
\brief Disconnects the PPPoE connection. enum EPppoeConnectionStatus { eConnected = 0, eConnecting = 1, ePoolRejected = 2, eDisconnected = 3, eTimeout = 4, eNoKeepAlive = 5, eAuthentcationFailed = 6 };- Specified by:
disconnectin interfacePPPoeClient- Parameters:
sessionId- Takes in a parameter of sessionIdstatus- Takes in a parameter of statussendTerminalFlag- Takes in a parameter of sendTerminalFlag
-
isConnected
public boolean isConnected()Information provided by the PKI file:
\brief Checks if it is connected. \return bool, true if connected, false if not.- Specified by:
isConnectedin interfacePPPoeClient- Returns:
- boolean Returns a boolean
-
setConnected
public void setConnected(boolean flag) Information provided by the PKI file:
\brief Set if it is connected. \param flag, true if connected, false if not.- Specified by:
setConnectedin interfacePPPoeClient- Parameters:
flag- Takes in a parameter of flag
-
getConnectionStatus
Information provided by the PKI file:
\brief Gets the connection status. \return PppoeConnectionStatus types: eConnected = 0, eConnecting = 1, ePoolRejected = 2, eDisconnected = 3, eTimeout = 4, eNoKeepAlive = 5, eAuthentcationFailed = 6- Specified by:
getConnectionStatusin interfacePPPoeClient- Returns:
- PPPoeConnectionStatus Returns a PPPoeConnectionStatus
-